<!doctype html>


<html>
<head>
  <link rel="shortcut icon" href="static/images/favicon.ico" type="image/x-icon">
  <title>datasource.js (Closure Library API Documentation - JavaScript)</title>
  <link rel="stylesheet" href="static/css/base.css">
  <link rel="stylesheet" href="static/css/doc.css">
  <link rel="stylesheet" href="static/css/sidetree.css">
  <link rel="stylesheet" href="static/css/prettify.css">

  <script>
     var _staticFilePath = "static/";
  </script>

  <script src="static/js/doc.js">
  </script>

  <meta charset="utf8">
</head>

<body onload="prettyPrint()">

<div id="header">
  <div class="g-section g-tpl-50-50 g-split">
    <div class="g-unit g-first">
      <a id="logo" href="index.html">Closure Library API Documentation</a>
    </div>

    <div class="g-unit">
      <div class="g-c">
        <strong>Go to class or file:</strong>
        <input type="text" id="ac">
      </div>
    </div>
  </div>
</div>





<div class="colmask rightmenu">
<div class="colleft">
    <div class="col1">
      <!-- Column 1 start -->

<div id="title">
       <span class="fn">datasource.js</span>
</div>

<div class="g-section g-tpl-75-25">
  <div class="g-unit g-first" id="description">
    Generic rich data access API.

 See <a href="http://wiki/Main/ClientDataSource">http://wiki/Main/ClientDataSource</a>
  </div>
  

        <div class="g-unit" id="useful-links">
          <div class="title">Useful links</div>
          <ol>
            <li><a href="closure_goog_datasource_datasource.js.source.html"><span class='source-code-link'>Source Code</span></a></li>
          </ol>
        </div>
</div>

<h2 class="g-first">File Location</h2>
  <div class="g-section g-tpl-20-80">
    <div class="g-unit g-first">
      <div class="g-c-cell code-label">datasource/datasource.js</div>
    </div>
  </div>
<hr/>


  <h2>Classes</h2>
 <div class="fn-constructor">
        <a href="class_goog_ds_DataNode.html">
          goog.ds.DataNode</a><br/>
        <div class="class-details">Interface for node in rich data tree.

Names that are reserved for system use and shouldn&#39;t be used for data node
names: eval, toSource, toString, unwatch, valueOf, watch. Behavior is
undefined if these names are used.</div>
 </div>
 <div class="fn-constructor">
        <a href="class_goog_ds_BaseDataNode.html">
          goog.ds.BaseDataNode</a><br/>
        <div class="class-details">Base class for data node functionality, has default implementations for
many of the functions.

implements goog.ds.DataNode</div>
 </div>
 <div class="fn-constructor">
        <a href="class_goog_ds_DataNodeList.html">
          goog.ds.DataNodeList</a><br/>
        <div class="class-details">Interface for node list in rich data tree.

Has both map and list-style accessors</div>
 </div>
 <div class="fn-constructor">
        <a href="class_goog_ds_BasicNodeList.html">
          goog.ds.BasicNodeList</a><br/>
        <div class="class-details">Simple node list implementation with underlying array and map
implements goog.ds.DataNodeList.

Names that are reserved for system use and shouldn&#39;t be used for data node
names: eval, toSource, toString, unwatch, valueOf, watch. Behavior is
undefined if these names are used.</div>
 </div>
 <div class="fn-constructor">
        <a href="class_goog_ds_EmptyNodeList.html">
          goog.ds.EmptyNodeList</a><br/>
        <div class="class-details">Immulatable empty node list</div>
 </div>
 <div class="fn-constructor">
        <a href="class_goog_ds_SortedNodeList.html">
          goog.ds.SortedNodeList</a><br/>
        <div class="class-details">Node list implementation which maintains sort order during insertion and
modification operations based on a comparison function.

The SortedNodeList does not guarantee sort order will be maintained if
the underlying data nodes are modified externally.

Names that are reserved for system use and shouldn&#39;t be used for data node
names: eval, toSource, toString, unwatch, valueOf, watch. Behavior is
undefined if these names are used.</div>
 </div>
      
<br/>

  <div class="legend">
        <span class="key publickey"></span><span>Public</span>
        <span class="key protectedkey"></span><span>Protected</span>
        <span class="key privatekey"></span><span>Private</span>
  </div>


  <h2>Global Functions</h2>





<div class="section">
  <table class="horiz-rule">


     <tr class="even entry public">
       <td class="access"></td>






  <td>
    <a name="goog.ds.Util.makeReferenceNode"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.ds.Util.</span><span class="entryName">makeReferenceNode<span class="args">(<span class="arg">node</span>,&nbsp;<span class="arg">name</span>)</span>
        </span>
        &#8658; <div class="fullType"><span>!</span><span class="type"><a href="class_goog_ds_DataNode.html">goog.ds.DataNode</a></span></div>
      </div>


     <div class="entryOverview">
       Create a data node that references another data node,
useful for pointer-like functionality.
All functions will return same values as the original node except for
getDataName()
     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">node</span>
        : <div class="fullType"><span>!</span><span class="type"><a href="class_goog_ds_DataNode.html">goog.ds.DataNode</a></span></div>
        <div class="entryOverview">The original node.</div>
     </td>
   </tr>
     
   <tr class="odd">
     <td>
        <span class="entryName">name</span>
        : <div class="fullType"><span class="type"><a href="http://www.google.com/url?sa=D&q=https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/String">string</a></span></div>
        <div class="entryOverview">The new name.</div>
     </td>
   </tr>
  </table>
      </div>
   
      <div class="detailsSection">
        <b>Returns:</b>&nbsp;<div class="fullType"><span>!</span><span class="type"><a href="class_goog_ds_DataNode.html">goog.ds.DataNode</a></span></div>&nbsp;
            The new data node.
      </div>
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="closure_goog_datasource_datasource.js.source.html#line623">code &raquo;</a>
  </td>
     </tr>


  </table>
</div>



  <h2>Global Properties</h2>





<div class="section">
  <table class="horiz-rule">


     <tr class="even entry public">
       <td class="access"></td>





  <a name="goog.ds.STR_ALL_CHILDREN_SELECTOR"></a>

  <td>


     <div class="arg">
        <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.ds.</span><span class="entryName">STR_ALL_CHILDREN_SELECTOR</span>
        : <div class="fullType"><span class="type"><a href="http://www.google.com/url?sa=D&q=https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/String">string</a></span></div>
     </div>


     <div class="entryOverview">
       The character denoting all children.
     </div>

  </td>


  <td class="view-code">
     <a href="closure_goog_datasource_datasource.js.source.html#line583">Code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry public">
       <td class="access"></td>





  <a name="goog.ds.STR_ARRAY_START"></a>

  <td>


     <div class="arg">
        <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.ds.</span><span class="entryName">STR_ARRAY_START</span>
        : <div class="fullType"><span class="type"><a href="http://www.google.com/url?sa=D&q=https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/String">string</a></span></div>
     </div>


     <div class="entryOverview">
       The character denoting the start of an array.
     </div>

  </td>


  <td class="view-code">
     <a href="closure_goog_datasource_datasource.js.source.html#line604">Code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry private">
       <td class="access"></td>





  <a name="goog.ds.STR_ATTRIBUTE_START_"></a>

  <td>


     <div class="arg">
        <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.ds.</span><span class="entryName">STR_ATTRIBUTE_START_</span>
        : <div class="fullType"><span class="type"><a href="http://www.google.com/url?sa=D&q=https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/String">string</a></span></div>
     </div>


     <div class="entryOverview">
       The character denoting an attribute.
     </div>

  </td>


  <td class="view-code">
     <a href="closure_goog_datasource_datasource.js.source.html#line576">Code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry public">
       <td class="access"></td>





  <a name="goog.ds.STR_PATH_SEPARATOR"></a>

  <td>


     <div class="arg">
        <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.ds.</span><span class="entryName">STR_PATH_SEPARATOR</span>
        : <div class="fullType"><span class="type"><a href="http://www.google.com/url?sa=D&q=https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/String">string</a></span></div>
     </div>


     <div class="entryOverview">
       The character denoting path separation.
     </div>

  </td>


  <td class="view-code">
     <a href="closure_goog_datasource_datasource.js.source.html#line597">Code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry public">
       <td class="access"></td>





  <a name="goog.ds.STR_WILDCARD"></a>

  <td>


     <div class="arg">
        <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.ds.</span><span class="entryName">STR_WILDCARD</span>
        : <div class="fullType"><span class="type"><a href="http://www.google.com/url?sa=D&q=https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/String">string</a></span></div>
     </div>


     <div class="entryOverview">
       The wildcard character.
     </div>

  </td>


  <td class="view-code">
     <a href="closure_goog_datasource_datasource.js.source.html#line590">Code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry public">
       <td class="access"></td>





  <a name="goog.ds.logger"></a>

  <td>


     <div class="arg">
        <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.ds.</span><span class="entryName">logger</span>
        : <div class="fullType"><span class="type"><a href="class_goog_debug_Logger.html">goog.debug.Logger</a></span></div>
     </div>


     <div class="entryOverview">
       Shared logger instance for data package
     </div>

  </td>


  <td class="view-code">
     <a href="closure_goog_datasource_datasource.js.source.html#line611">Code &raquo;</a>
  </td>
     </tr>


  </table>
</div>



      <!-- Column 1 end -->
    </div>

        <div class="col2">
          <!-- Column 2 start -->
          <div class="col2-c">
            <h2 id="ref-head">Directory datasource</h2>
            <div id="localView"></div>
          </div>

          <div class="col2-c">
            <h2 id="ref-head">File Reference</h2>
            <div id="sideFileIndex" rootPath="closure/goog" current="datasource/datasource.js"></div>
          </div>
          <!-- Column 2 end -->
        </div>
</div>
</div>

</body>
</html>
